声明

本文是学习GB-T 34997-2017 中文办公软件 网页应用编程接口. 而整理的学习笔记,分享出来希望更多人受益,如果存在侵权请及时联系我们

1 范围

本标准规定了中文办公软件的网页应用编程接口，包括文件接口、界面控制接口、查找替换接口、书
签接口、文档编辑接口、页面设置接口、表格接口、图片接口、文本框接口、插入内容接口、修订和审批接

口、自定义域处理接口和基础监听接口等接口定义。

本标准适用于中文办公软件产品文字处理组件和网页集成应用的开发和测试。

2 规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文

件。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。

GB/T 20916 中文办公软件文档格式规范

3 术语和定义

下列术语和定义适用于本文件。

3.1

接口定义语言 interface definition language

用于描述对象实现所提供的，客户端对象所调用的服务接口的描述语言。

4 接口描述

4.1 插件初始化

功能说明：

初始化插件。

接口原型：

object init(string tagID, string width, string height)

参数说明(3个参数):

— — 参数1:tagID 插件所处网页标签的 id位置；

—— 参数2:width 插件宽度，单位像素；

—— 参数3:height 插件高度，单位像素。

返回值说明：

成功则返回初始化后的插件对象；失败则返回 null。

备注：

tagID所对应的标签的 innerHTML 内容替换为插件；width 和 height遵循 html
规范的要求。

本接口仅用于打开单个文件。

GB/T 34997—2017

4.2 文件接口

4.2.1 创建空文件

功能说明：

创建空文件。

接口原型：

boolean createDocument(string type)

参数说明(1个参数):

参数1:type 文件类型，uot表示符合GB/T 20916 的文字处理文档。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.2.2 打开本地文档

功能说明：

打开本地文件。

接口原型：

boolean openDocument(string fileName, boolean readOnly)

参数说明(2个参数):

——参数1:fileName 本地文件的全路径，包括扩展名；

— 参数2:readOnly 为 true时表示按只读打开，否则按可编辑打开。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

如果扩展名是文档模板，如为"uott",则按模板创建符合GB/T 20916 的新文档。

4.2.3 打开远程文档

功能说明：

打开远程文件。

接口原型：

boolean openDocumentRemote(string URL, boolean readOnly)

参数说明(2个参数):

——参数1:URL 远程文件的 URL 全路径，包括扩展名；

— 参 数 2 :readOnly 为 true时表示按只读打开，否则按可编辑打开。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

如果扩展名是文档模板，如"uott",则按模板创建一新文件。

4.2.4 以监听模式打开文档

功能说明：

GB/T 34997—2017

以监听模式打开一个文档，该函数仅适用于插件且弹出式(非嵌入式)窗口模式。

接口原型：

boolean openFileWithListener(string fileName, boolean readOnly)

参数说明(2个参数):

— 参 数 1 :fileName 本地文件的全路径，包括扩展名；

— — 参数2:readOnly 为 true时表示按只读打开，否则按可编辑打开。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

如果扩展名是文档模板，如“uott”,则按模板创建一新文件。

4.2.5 保存到本地

功能说明：

将文件保存在本地，扩展名是模板则保存为模板，不弹出对话框。

接口原型：

boolean saveAs(string fileName)

参数说明(1个参数):

参数1:fileName 本地文件的全路径，包括扩展名。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.2.6 通过对话框保存到本地

功能说明：

通过弹出对话框将文件保存在本地。

接口原型：

boolean saveAs()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.2.7 保存到远程

功能说明：

将文件保存到远程地址。

接口原型：

boolean saveURL(string URL, string fileName)

参数说明(2个参数):

—— 参数1:URL 处理系统提供的页面地址；

—— 参数2:fileName 文件名，包括扩展名。

返回值说明：

GB/T 34997—2017

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.2.8 打印

功能说明：

不调对话框打印当前文件。

接口原型：

boolean print()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

当未设置默认的本地打印机或无法直接打印时，弹出打印对话框。

4.2.9 调用打印对话框

功能说明：

调用打印对话框。

接口原型：

boolean showPrintDialog()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.2.10 打印预览

功能说明：

打印预览功能。

接口原型：

boolean printPreview()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.2.11 打印设置

功能说明：

设定内容打印设置。

接口原型：

boolean printSetting(int nPrint)

参数说明(1个参数):

GB/T 34997—2017

参数1:nPrint
打印设置参数，为以下取值的和。1表示页面背景，2表示图片和对象，4表示

隐藏的文字，8表示文字占位符，16表示表单控件。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.2.12 打印/不打印修订文字

功能说明：

按照参数要求直接打印。

接口原型：

boolean printRevision(int enable)

参数说明(1个参数):

参数1:enable
为0表示打印修订状态；为1表示打印原始状态(修订前);为2表示打印最终

状态(修订后)。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.2.13 关闭

功能说明：

关闭文档。

接口原型：

boolean close()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.2.14 以监听模式关闭文档

功能说明：

以监听模式关闭文档，该函数仅适用于插件且弹出式(非嵌入式)窗口模式。

接口原型：

boolean closeFileWithCloseListener()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

GB/T 34997—2017

4.3 界面控制接口

4.3.1 显示/隐藏工具菜单

功能说明：

显示或隐藏全部工具菜单。

接口原型：

boolean setToolbarAllVisible(boolean enable)

参数说明(1个参数):

参数1:enable为 true表示显示，为 false表示不显示。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.3.2 显示/隐藏指定工具菜单

功能说明：

显示或隐藏指定工具菜单。

接口原型：

boolean setToolbarPartVisible(int toolbarNum,boolean enable)

参数说明(2个参数):

— — 参数1:toolbarNum 工具栏编号，编号含义见表1。

表 1 工具栏编号及含义

GB/T 34997—2017

表 1(续)

——参数2:enable为 true表示显示，为 false表示不显示。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.3.3 设置为只读

功能说明：

动态设置文档为只读或恢复可编辑。

接口原型：

boolean enableProtect(boolean enable)

参数说明(1个参数):

参数1:enable 为 true表示不可编辑，false表示可编辑。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

GB/T 34997—2017

备注：

无 。

4.3.4 获取文档是否只读状态

功能说明：

判断当前文档是否是只读状态。

接口原型：

boolean isReadOnly()

参数说明：无。

返回值说明：

true表示文档只读；false表示文档可编辑。

备注：

无 。

4.3.5 设置文档是否被修改状态

功能说明：

设置当前文档是否被修改的状态。

接口原型：

boolean setModified(bModified)

参数说明(1个参数):

参数1:bModified 文件是否被修改，true表示已被修改，false表示未被修改。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.3.6 获取当前文档是否被修改状态

功能说明：

判断当前文档是否被修改。

接口原型：

boolean isModified()

参数说明：无。

返回值说明：

true文档已被修改，false文档未被修改。

备注：

无 。

4.3.7 光标定位文档头部

功能说明：

光标定位到文档头部。

接口原型：

void cursorToDocStart()

参数说明：无。

GB/T 34997—2017

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.3.8 光标定位文档尾部

功能说明：

光标定位到文档尾部。

接口原型：

cursorToDocEnd()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.3.9 光标定位到指定的自定义域

功能说明：

光标定位到文档尾部。

接口原型：

cursorToDocumentField(string id)

参数说明：

参数1:id 自定义域标识符。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.3.10 光标前进一格

功能说明：

光标前进一格，即右移一格。

接口原型：

boolean moveRight()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.3.11 光标退格

功能说明：

光标退格，即左移一格。

接口原型：

GB/T 34997—2017

boolean moveLeft()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.3.12 光标上移一行

功能说明：

光标上移一行。

接口原型：

boolean moveUp()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.3.13 光标下移一行

功能说明：

光标下移一行。

接口原型：

boolean moveDown()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.3.14 禁止内容复制

功能说明：

启用或禁止复制。

接口原型：

boolean enableCopy(boolean enable)

参数说明(1个参数):

参数1:enable 为 true表示允许复制，为 false表示不允许复制。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

同时设置菜单、工具栏、快捷键和右键的功能。

4.3.15 禁止内容剪切

功能说明：

GB/T 34997—2017

启用或禁止剪切。

接口原型：

boolean enableCut(boolean enable)

参数说明(1个参数):

参数1:enable 为 true表示允许剪切，为 false 表示不允许剪切。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

同时设置菜单、工具栏、快捷键和右键的功能。

4.3.16 开启/停止修订

功能说明：

开启或停止修订。

接口原型：

boolean enableRevision(boolean enable)

参数说明(1个参数):

参数1:enable 为 true表示开启修订，为 false表示停止修订。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.3.17 设置鼠标操作属性

功能说明：

是否可用鼠标的各项操作。该功能作用于当前文档。

接口原型：

boolean enableMouseHandle(int buttonType,boolean enable)

参数说明(2个参数):

—— 参数1:buttonType
鼠标键的标识，同时按下则数值相加。1表示左键，2表示右键，4表示

中键。

——参数2:Enable 是否可用，true表示可用，false 表示禁用。

返回值说明：

true 表示设置成功；false 表示设置失败。

备注：

无。

4.4 查找替换接口

4.4.1 查找替换所有文本

功能说明：

用指定的内容替换文档中所有指定的文字。

接口原型：

int findAndReplaceText(string txtl,string txt2)

GB/T 34997—2017

参数说明(2个参数):

—— 参数1:txtl 需要查找的文字；

—— 参数2:txt2 用于替换的文字。

返回值说明：

函数返回值说明表示搜索替换的位置个数；文档为只读状态查找替换失败返回值说明为0。

备注：

无。

4.4.2 查找替换第一处文本

功能说明：

用指定的内容替换文档中第一处出现的指定文字。

接口原型：

int findAndReplaceFirstText(string txtl,string txt2)

参数说明(2个参数):

—— 参数1:txt1 需要查找的文字；

—— 参数2:txt2 用于替换的文字。

返回值说明：

函数返回值说明表示搜索替换的位置个数；文档为只读状态查找替换失败返回值说明为0。

备注：

无。

4.4.3 显示查找对话框

功能说明：

调用查找替换对话框。

接口原型：

boolean showSearchDialog()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.4.4 查找文本

功能说明：

查找文本内容。如果查找成功，将查找到的内容选中。

接口原型：

boolean searchText(string sText,boolean bForward,string type)

参数说明(2个参数):

—— 参数1:sText 要查找的文本内容；

— 参数2:bForward
查找方向，true表示查询方向从光标当前位置向后查找直到文档结尾，再
从文档开头向后查找到光标位置；false表示查询方向从光标当前位置向前查找直到文档开

头，再从文档结尾向前查找到光标位置；

—— 参数3:type full表示全字匹配；part表示部分匹配。

GB/T 34997—2017

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.4.5 获取文档全部文本

功能说明：

获取当前文档中全部文本内容。

接口原型：

string getDocumentText()

参数说明：无。

返回值说明：

当前打开文档中全部文本内容。

备注：

无。

4.5 书签接口

4.5.1 在光标位置创建书签

功能说明：

在光标选择的位置创建书签。

接口原型：

void createBookmarkAtSelection(string name)

参数说明(1个参数):

参数1:name 书签名称。

返回值说明：

false表示如果文档为只读状态返回或者书签名称重复，创建书签失败；true表示创建书签

成功。

备注：

无。

4.5.2 光标跳至书签位置

功能说明：

光标跳至指定书签的位置。

接口原型：

void cursorToBookmark(string bookmarkName)

参数说明(1个参数):

参数1:bookmarkName 书签名称。

返回值说明：

书签的文本内容。

备注：

无。

GB/T 34997—2017

4.5.3 替换书签名称

功能说明：

替换书签名称。

接口原型：

boolean replaceBookmarkName(string oldName, string newdName)

参数说明(2个参数):

参数1;oldName 旧书签名：

——参数2:newdName 新书签名。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.5.4 删除书签

功能说明：

删除书签。

接口原型：

boolean deleteBookmark(string name)

参数说明(1个参数):

参数1:name 书签名。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.5.5 替换书签内容

功能说明：

替换书签内容

接口原型：

boolean replaceBookmarkText(string replaceText)

参数说明(1个参数):

参数1:replaceText 替换书签的内容。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.5.6 按书签名称查找

功能说明：

按书签名称查找书签。

接口原型：

boolean findBookmark(string name)

GB/T 34997—2017

参数说明(1个参数):

参数1:name 书签名称。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.5.7 获取书签文本内容

功能说明：

获取书签文本内容。

接口原型：

string getBookmarkText(string name)

参数说明(1个参数):

参数1:name 书签名称。

返回值说明：

书签文本内容。

备注：

无。

4.5.8 获取书签个数

功能说明：

获取全文书签个数。

接口原型：

int countBookmark()

参数说明：无。

返回值说明：

书签个数。

备注：

无。

4.5.9 获取书签列表

功能说明：

获取所有书签的名称。

接口原型：

array getAllBookmarkName()

参数说明：无。

返回值说明：

全部书签名称的字符串列表。

备注：

无。

GB/T 34997—2017

4.6 文档编辑接口

4.6.1 图片插入到文档当前位置

功能说明：

在当前光标位置嵌入式，用户可调大小。

接口原型：

boolean insertPicture(string pictureFile)

参数说明(1个参数):

参数1:pictureFile本地图片用文件名，远程图片用URL。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

用于公文正文插图。

4.6.2 本地图片插入到文档指定位置

功能说明：

在指定坐标位置插入指定大小的图片，用户可调大小。

接口原型：

boolean insertPicture(string pictureFile, int left, int top, int
width, int height)

参数说明(5个参数):

— 参 数 1 :pictureFile 本地图片用文件名，远程图片用URL;

—— 参数2:left 相对于页面左上角的横坐标，单位为毫米(mm);

— — 参数3:top 相对于页面左上角的纵坐标，单位为毫米(mm);

— — 参数4:width 图片宽度，单位为毫米(mm);

— — 参数5:height 图片高度，单位为毫米(mm)。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

可用于插入二维码。

4.6.3 提取全文文本

功能说明：

返回全文的无格式文本。

接口原型：

string getText()

参数说明：无。

返回值说明：

全文文本的字符串。

备注：

不含格式控制符。

GB/T 34997—2017

4.6.4 设置段落首行缩进

功能说明：

设置光标所选段落的首行缩进。

接口原型：

void setFirstLinelndent(float linelndent)

参数说明(1个参数):

参数1:linelndent 缩进值。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.6.5 设置段落间距

功能说明：

设置光标所选内容所在段的段间距。

接口原型：

void setParagraphSpacing(float paragraphSpacing)

参数说明(1个参数):

参数1:paragraphSpacing 段间距大小，单位为行距的倍数。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.7 页面设置接口

4.7.1 设置页面显示比例

功能说明：

设置页面显示比例。

接口原型：

void zoom(string zoomValue)

参数说明(1个参数):

参数1:zoomValue 页面显示比例的值。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.7.2 获取当前页面比例

功能说明：

获取页面显示比例的值。

接口原型：

GB/T 34997—2017

String getZoomValue()

参数说明：无。

返回值说明：

返回页面显示比例值。

备注：

无。

4.8 表格接口

4.8.1 设置单元格保护属性

功能说明：

对指定表格的指定单元格设置保护或取消保护操作。

接口原型：

boolean setCellProtected(string tableName,int columnCount,int
rowCount,boolean isPro-

tected)

参数说明(4个参数):

——参数1:tableName 表格名称；

——参数2:rowCount 单元格所在表格的行数；

——参数3:columnCount 单元格所在表格的列数；

— 参数4:isProtected
保护/取消保护指定单元格，true表示保护指定单元格，false 表示取消保

护指定单元格。

返回值说明：

如果文档为只读状态返回值说明 false;设置成功返回 true。

备注：

无 。

4.8.2 光标定位单元格

功能说明：

光标跳至指定表格指定单元格。

接口原型：

void cursorToCell(string tableName,int columnCount,int rowCount)

参数说明(3个参数):

——参数1:tableName 表格名称；

——参数2:rowCount 单元格所在表格行号；

——参数3:columnCount 单元格所在表格列号。

返回值说明：

操作成功返回 true;操作失败返同 false.

备注：

无 。

4.8.3 在鼠标位置插入表格

功能说明：

在鼠标选择的位置插入表格。

GB/T 34997—2017

接口原型：

void insertTableAtSelection(string tableName,int columnCount,int
rowCount)

参数说明(3个参数):

— 参 数 1 :tableName 表格名称；

— — 参数2:columnCount 表格的列数；

参数3:rowCount 表格的行数。

返回值说明：

如果文档为只读状态返回false,插入表格失败；插入表格成功返回 true。

备注：

无。

4.8.4 调用表格对话框

功能说明：

调用插入表格对话框。

接口原型：

void insertTableDialog()

参数说明：无。

返回值说明：

如果文档为只读状态返回
false,弹出插入表格对话框失败；弹出插入表格对话框成功返回

true。

备注：

无。

4.8.5 删除指定表格

功能说明：

删除指定名称的表格。

接口原型：

void removeTable(string tableName)

参数说明(1个参数):

参数1:tableName 表格名称。

返回值说明：

删除表格成功返回 true;删除表格失败返回 false。

备注：

无。

4.8.6 设置表格的行高

功能说明：

设置表格的行高。

接口原型：

boolean setRowHeight(string tableName, int num, double height)

参数说明(3个参数):

— — 参数1:tableName 表格名称；

— 参 数 2 :num 表格行数，从1开始；

GB/T 34997—2017

— — 参数3:height 行高度，单位为毫米(mm)。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.8.7 设置表格的列宽

功能说明：

设置表格的行高。

接口原型：

boolean setColumnWidth(string tableName, int num,double width)

参数说明(3个参数):

—— 参数1:tableName 表格名称；

— — 参数2 :num 表格列数，从1开始；

— — 参数3:height 列宽度，单位为毫米(mm)。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.9 图片接口

4.9.1 在光标位置插入图片

功能说明：

在光标所在位置插入图片。

接口原型：

void insertlmageAtSelection(string URL,float width,float height)

参数说明(3个参数):

— — 参数1:URL 图片的存放路径；

—— 参数2:width 图片宽度，单位为毫米(mm);

— — 参数3:height 图片高度，单位为毫米(mm)。

返回值说明：

如果文档为只读状态返回null,插入图片失败；插入图片成功返回一个图片对象。

备注：

无。

4.9.2 调用插入图片对话框

功能说明：

调用"插入图片"对话框。

接口原型：

boolean insertImageDialog()

参数说明：无。

返回值说明：

GB/T 34997—2017

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.10 文本框接口

4.10.1 光标定位文本框

功能说明：

光标定位指定文本框。

接口原型：

boolean cursorToTextFrame(string frameName)

参数说明(1个参数):

参数1:frameName 文本框名称。

返回值说明：

操作成功返回 true,操作失败返回 false。

备注：

无。

4.10.2 设置文本框文字方向

功能说明：

设置文本框文字方向。

接口原型：

void setTextFrameDirection(boolean textDirection)

参数说明(1个参数):

参数1:textDirection 文本框的文字方向，landscape表示横向，portrait
表示纵向。

返回值说明：

操作成功返回 true,操作失败返回 false。

备注：

无。

4.11 插入内容接口

4.11.1 光标位置插入文本

功能说明：

在光标所在位置插入文本内容。

接口原型：

boolean insertText(string title)

参数说明(1个参数):

参数1:title 插入的内容。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

GB/T 34997—2017

4.11.2 插入文档页码

功能说明：

在文档中插入页码。

接口原型：

boolean insertPageNumber()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.11.3 插入页眉

功能说明：

插入页眉。

接口原型：

boolean insertPageHeader()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.11.4 插入页脚

功能说明：

插入页脚。

接口原型：

boolean insertPageFooter()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.11.5 光标位置插入时间

功能说明：

在光标所在位置插入时间。

接口原型：

boolean insertTime(date sFormat)

参数说明(1个参数):

参数1:sFormat 时间格式，示例见表2。

GB/T 34997—2017

表 2 时间格式表示

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.11.6 插入工作表

功能说明：

电子表格中插入工作表。

接口原型：

boolean insertSheet(string name,int index)

参数说明(2个参数):

— 参 数 1 :name 工作表的名称；

——参数2:index 工作表的位置。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.11.7 退格操作

功能说明：

光标从当前位置执行退格操作。

接口原型：

boolean backspace()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.12 修订和审批接口

4.12.1 禁用/启用工具栏中接受修订按钮

功能说明：

禁用或启用工具栏中接受修订按钮。

GB/T 34997—2017

接口原型：

boolean enableRevisionAcceptCommand(boolean enable)

参数说明(1个参数):

参数1:enable 为 true表示启用接受修订按钮，为
false表示禁用接受修订按钮。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.12.2 禁用/启用工具栏中拒绝修订按钮

功能说明：

禁用或启用工具栏中拒绝修订按钮。

接口原型：

boolean enableRevisionRejectCommand(boolean enable)

参数说明(1个参数):

参数1:enable 为 true表示启用拒绝修订按钮，为
false表示禁用拒绝修订按钮。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.12.3 显示修订文字的状态

功能说明：

显示修订文字的状态。

接口原型：

boolean showRevision(int enable)

参数说明(1个参数):

参数1:enable
为0表示显示修订状态；为1表示显示原始状态(修订前);为2表示显示最终

状态(修订后)。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.12.4 设置审批用批注或修订的用户名

功能说明：

设置审批用批注或修订的用户名。

接口原型：

boolean setUserName(string userName)

参数说明(1个参数):

参数1:userName 为要使用的用户名。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

GB/T 34997—2017

备注：

一般通过设置办公软件当前的用户名。

4.12.5 获取审批用批注或修订的用户名

功能说明：

获取审批用批注或修订的用户名。

接口原型：

string getUserName()

参数说明：无。

返回值说明：

当前的用户名。

备注：

一般获取办公软件当前的用户名。

4.12.6 按用户接受批注或修订

功能说明：

根据指定作者筛选修订，并接受或拒绝其修订。

接口原型：

void filterCertainAuthor(string author,boolean bAccept)

参数说明(2个参数):

—— 参数1:author 指定修订的作者；

— — 参数2:bAccept 接受或拒绝标志位，true表示接受，false 表示拒绝。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.12.7 获取修订状态

功能说明：

获取当前文档的修订状态。

接口原型：

boolean getRecensionStatus()

参数说明：无。

返回值说明：

true表示文档为开启修订状态；false表示文档为关闭修订状态。

备注：

无 。

4.12.8 获取所有修订内容

功能说明：

获取文档中所有修订内容。

接口原型：

string getAllRevisions()

GB/T 34997—2017

参数说明：无。

返回值说明：

为文档中所有修订内容，包括：修订内容，用户名称和修订时间。

备注：

无。

4.12.9 接受所有修订

功能说明：

接受所有修订者的修订内容。

接口原型：

boolean acceptAllChanges()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.12.10 拒绝所有修订

功能说明：

拒绝所有修订者的修订内容。

接口原型：

void rejectAllChanges()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.13 自定义域处理接口

4.13.1 增加自定义域

功能说明：

在光标当前位置增加自定义域。

接口原型：

boolean insertDocumentField(string id)

参数说明(1个参数):

参数1:id 自定义域 ID。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.13.2 修改自定义域内容

功能说明：

GB/T 34997—2017

设置自定义域的值，替换旧数据。

接口原型：

boolean setDocumentField(string id, string value)

参数说明(2个参数):

——参数1:id 自定义域标识符；

——参数2:value 新值。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.13.3 获取自定义域列表

功能说明：

获取所有自定义域的标识符。

接口原型：

array getAllDocumentField()

参数说明：无。

返回值说明：

全部自定义域 id 的字符串列表。

备注：

无 。

4.13.4 删除自定义域

功能说明：

删除指定自定义域。

接口原型：

boolean deleteDocumentField(string id)

参数说明(1个参数):

参数1:id 自定义域标识符。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.13.5 设置自定义域背景是否显示

功能说明：

设置自定义域背景是否可显示。

接口原型：

boolean showDocumentField(string id, boolean enable)

参数说明(2个参数):

——参数1:id 自定义域标识符；

——参数2:enable 为 true表示可见，为 false表示不可见。

返回值说明：

GB/T 34997—2017

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.13.6 获取自定义域内容

功能说明：

返回指定自定义域的值。

接口原型：

string getDocumentFieldValue(string id)

参数说明(1个参数):

参数1:id 自定义域标识符。

返回值说明：

指定自定义域的纯文本文字。

备注：

表格返回纯文本，图片不返回数据。

4.13.7 设置自定义域是否可用可编辑

功能说明：

设置自定义域是否可用可编辑。

接口原型：

boolean enableDocumentField(string id, boolean enable)

参数说明(2个参数):

——参数1:id 自定义域标识符；

——参数2:enable 为 true表示内容可编辑，为 false表示内容不可编辑。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.13.8 自定义域插入文档内容

功能说明：

在指定自定义域插入文档。

接口原型：

boolean insertDocument(string id, string fileNameURL)

参数说明(2个参数):

——参数 l:id 自定义域标识符；

——参数2:fileNameURL 需要插入的文档全路径。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

内容全部换为文件的内容。

4.13.9 移动光标到自定义域指定位置

功能说明：

GB/T 34997—2017

将光标移动到指定名称自定义域。

接口原型：

boolean cursorToDocumentField(string id, int position)

参数说明(2个参数):

参数1:id 自定义域标识符；

— 参 数 2 :position
光标移动到自定义域的位置，1指自定义域标记前部，2指自定义域标记后

部，3指自定义域文本前端，4指自定义域文本后端。

返回值说明：

true表示接口调用成功，功能能够实现；

false 表示接口调用失败，功能未能实现。

备注：

无。

4.14 基础监听接口

4.14.1 设置是否监听

功能说明：

是否监听指定的事件消息。该功能作用于当前窗口。

接口原型：

boolean notifyEvent(string eventName,boolean bNotify)

参数说明(2个参数):

——参数1:eventName 监听的具体消息名称对应的字符串，消息名称见附录 A
的表 A.1;

— 参 数 2 :bNotify 是否进行监听。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无。

4.14.2 注销指定监听

功能说明：

注销指定的监听。

接口原型：

boolean unRegistListener(string strListenerName)

参数说明(1个参数):

参数1:strListenerName 监听类型名。

返回值说明：

true表示注销操作成功；false表示注销操作失败。

备注：

无。

4.14.3 注册监听程序

功能说明：

注册程序监听，常用于具体应用的二次封装。

GB/T 34997—2017

接口原型：

boolean registPluginListener(string strListenerName, string
strFunctionName, boolean

bRegist)

参数说明(3个参数):

— 参 数 1 :strListenerName 监听的类型名称对应的字符串；

参数2:strFunctionName 监听回调函数的前缀名；

— 参 数 3 :bRegist 是否注册监听。

返回值说明：

true 表示监听操作成功；false表示监听操作失败。

备注：

无 。

4.14.4 设置监听预制数据

功能说明：

设置回调函数的预置数据，常用于具体应用的二次封装。

接口原型：

boolean setListenerPresetData(string strListenerName, string
strFunctionName, string

pData)

参数说明(3个参数):

— — 参数1:strListenerName 监听的类型名称对应的字符串；

— 参数2:strFunctionName 回调函数的名称；

— — 参数3:pData 预置数据。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

4.14.5 通知回调函数启用

功能说明：

通知插件该函数所在页面的监听回调机制已启动，它与页面的回调启动函数
listenerEntry 绑

定使用。

接口原型：

void updateListener()

参数说明：无。

返回值说明：

true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。

备注：

无 。

GB/T 34997—2017

附 录 A

(规范性附录)

事件监听的消息名称表

事件监听的消息名称表如表 A.1 所示。

表 A.1 事件监听的消息名称表

style="width:3.07996in" />GB/T 34997—2017

延伸阅读

更多内容 可以 GB-T 34997-2017 中文办公软件 网页应用编程接口. 进一步学习

联系我们

T-CAEPI 69—2023 固体废物资源化产物环境风险评价通用指南.pdf